[codex] Add Windows TSF IME insertion support by millionart · Pull Request #214 · Open-Less/openless

millionart · 2026-05-03T15:55:39Z

User description

Summary

Adds Windows TSF IME insertion support so OpenLess can commit dictated text through the active Windows text service instead of relying only on non-TSF fallback paths.

This PR also hardens the Windows packaging and registration flow:

builds and registers both x64 and Win32 OpenLess IME DLLs
registers COM/TSF using the correct 64-bit and 32-bit registry views
uses side-by-side registration staging paths so running host apps cannot lock the next build output
packages both IME DLLs into the Windows MSI
restores the previous IME profile after prepared insertion sessions

Fixes Included

Battle.net: supports 32-bit host processes by building and registering the Win32 IME DLL.
Microsoft Word: retries TF_E_SYNCHRONOUS rejections with an async TSF edit session.
Microsoft Word: moves the caret to the end of inserted text after commit by collapsing the committed range and setting selection.

Validation

node scripts/windows-package-msvc.test.mjs
x64 OpenLessIme.dll Release build: 0 warnings, 0 errors
Win32 OpenLessIme.dll Release build: 0 warnings, 0 errors
Local Battle.net manual test: text commits successfully
Local Microsoft Word manual test: text commits successfully and caret lands after inserted text

PR Type

Enhancement, Bug fix, Tests

Description

Add session-aware Windows TSF insertion flow
Restore IME profile after canceled sessions
Gate non-TSF fallback behind preference
Expose IME status, packaging, and tests

Diagram Walkthrough

flowchart LR
  A["Settings preference"] -- "toggle fallback" --> B["Coordinator session flow"]
  B -- "prepare / submit / restore" --> C["Windows IME session controller"]
  C -- "capture profile" --> D["TSF profile manager"]
  C -- "send text" --> E["IME IPC protocol"]
  E -- "pipe submit" --> F["OpenLess IME DLL"]
  C -- "status" --> G["Settings UI"]

File Walkthrough

Relevant files

Enhancement

25 files

coordinator.rs `Make session lifecycle IME-aware`	+391/-47
windows_ime_profile.rs `Manage TSF profile capture and restore`	+660/-0
windows_ime_ipc.rs `Add named-pipe IME submission transport`	+414/-0
windows_ime_session.rs `Coordinate TSF preparation, submit, restore`	+224/-0
windows_ime_protocol.rs `Define IME pipe messages and names`	+173/-0
lib.rs `Expose IME command and modules`	+28/-9
types.rs `Add Windows IME status and fallback pref`	+42/-2
insertion.rs `Add Windows Unicode keystroke fallback`	+66/-6
commands.rs `Expose Windows IME status command`	+6/-1
Settings.tsx `Add Windows IME controls to settings`	+48/-0
zh-CN.ts `Translate Windows IME settings strings`	+12/-0
en.ts `Add English Windows IME copy`	+12/-0
ipc.ts `Mock Windows IME status in client`	+13/-0
types.ts `Add Windows IME status interfaces`	+15/-0
ipc_client.cpp `Implement IME client pipe communication`	+511/-0
registry.cpp `Handle IME registry keys and paths`	+307/-0
text_service.cpp `Implement TSF text service behavior`	+332/-0
edit_session.cpp `Manage IME edit sessions and commits`	+125/-0
class_factory.cpp `Expose IME COM class factory`	+75/-0
text_service.h `Declare TSF text service interface`	+54/-0
dllmain.cpp `Initialize IME DLL entry points`	+54/-0
edit_session.h `Declare IME edit session helpers`	+43/-0
ipc_client.h `Declare IME IPC client interface`	+37/-0
class_factory.h `Declare IME class factory types`	+20/-0
registry.h `Declare IME registry helper functions`	+6/-0

Formatting

2 files

hotkey.rs `Reformat hotkey handlers and flag updates`	+20/-11
selection.rs `Reflow Windows paste input imports`	+4/-3

Tests

3 files

windows-real-asr-insertion-smoke.ps1 `Support Win32 edit host smoke tests`	+76/-7
windows-smoke-suite.ps1 `Extend smoke suite with Win32 edit`	+2/-2
windows-package-msvc.test.mjs `Test Windows packaging and registration`	+107/-0

Configuration changes

13 files

windows-package-msvc.ps1 `Package Windows IME artifacts and MSI`	+316/-0
windows-ime-build.ps1 `Build Windows IME DLL artifacts`	+82/-0
windows-ime-register.ps1 `Register Windows IME COM and TSF`	+78/-0
windows-ime-unregister.ps1 `Remove Windows IME registration entries`	+65/-0
OpenLessIme.vcxproj `Configure IME DLL project settings`	+159/-0
openless-ime.wxs `Bundle IME DLLs into MSI`	+54/-0
OpenLessIme.sln `Add Windows IME solution entry`	+27/-0
resource.rc `Add IME version and resources`	+33/-0
guids.h `Define COM and TSF GUIDs`	+21/-0
windows-package-msvc.cmd `Wrap Windows package build script`	+8/-0
windows-preflight.ps1 `Add Windows packaging preflight checks`	+63/-1
tauri.conf.json `Update Tauri bundling and commands`	+11/-0
OpenLessIme.def `Export IME DLL COM symbols`	+6/-0

Documentation

2 files

2026-05-01-windows-temporary-tsf-ime.md `Document temporary TSF IME rollout plan`	+2191/-0
2026-05-01-windows-temporary-tsf-ime-design.md `Document TSF IME design details`	+143/-0

Dependencies

1 files

Cargo.toml `Add Windows IME crate dependencies`	+7/-2

github-actions · 2026-05-03T16:01:00Z

PR Reviewer Guide 🔍

Here are some key observations to aid the review process:

⏱️ Estimated effort to review: 4 🔵🔵🔵🔵⚪
🧪 PR contains tests
🔒 No security concerns identified
⚡ Recommended focus areas for review Broken profile restore Saving `profile.clsid` and `profile.guidProfile` with `Debug` formatting makes the captured text-service snapshot non-round-trippable. `restore_profile()` later parses those fields as GUID strings, so restoring the original IME profile after a TSF session will fail for any text-service profile, and the active-profile check can also stop recognizing OpenLess as active. if profile.dwProfileType == TF_PROFILETYPE_INPUTPROCESSOR { Ok(ImeProfileSnapshot::text_service( profile.langid, format!("{:?}", profile.clsid), format!("{:?}", profile.guidProfile), )) } else { keyboard_layout_snapshot_from_tsf(profile.langid, profile.hkl) }

millionart added 30 commits May 1, 2026 18:05

docs: design temporary TSF IME flow

7005a06

chore: ignore local worktrees

14cacc6

docs: plan temporary TSF IME implementation

271a51a

feat: add Windows IME IPC protocol

83426bc

feat: add Windows IME profile state

6d08850

fix: validate Windows IME profile snapshots

45aae5e

feat: manage Windows TSF input profiles

975d633

fix: query active keyboard TIP profile

d48fad6

fix: capture TSF keyboard layout profile

6b50b0f

feat: add Windows IME IPC client

d4655b7

feat: route Windows insertion through temporary TSF IME

3a6f7f3

fix: report inactive Windows IME session

49b55f1

fix: scope Windows IME session restore by dictation

a1bc871

fix: ignore stale dictation startup continuations

39d766d

feat: scaffold OpenLess TSF IME DLL

e950d1d

fix: export OpenLess IME COM entry points

4208deb

fix: register OpenLess IME keyboard category

1ab6f7b

feat: commit dictated text through TSF edit sessions

0f28bb1

fix: remove COM destructor override specifiers

b34d450

fix: build OpenLess IME DLL with installed SDK libs

e714fd2

feat: receive OpenLess IME submissions over a named pipe

52f7de5

feat: add Windows IME build and registration scripts

7225caa

feat: show Windows TSF IME backend status

f5624f7

fix: mark browser IME mock as non-Windows

35c2bbb

fix: check TSF profile registration in HKLM

e8bc4af

fix: activate Windows IME profile for session scope

57a562c

fix: require admin for Windows IME registration

300d01e

fix: register Windows IME COM server system-wide

0e4747d

fix: avoid clipboard fallback for Windows voice insertion

c3b5932

feat: add Windows TSF-only insertion toggle

a6e49b9

millionart added 7 commits May 3, 2026 19:03

fix: package and register Windows TSF IME

865e432

merge Windows TSF IME support

f497cd4

merge upstream main before TSF PR

4e4f3d1

fix: restore IME profile after skipped insertion

ab7d1bc

fix: register 32-bit Windows IME

cb10e0d

fix: support async Word IME commits

152e38c

fix: move Word caret after IME commit

8cb289e

millionart closed this May 3, 2026

github-actions Bot added the Review effort 4/5 label May 3, 2026

millionart deleted the codex-fix-windows-ime-x86-registration branch May 8, 2026 11:34

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[codex] Add Windows TSF IME insertion support#214

[codex] Add Windows TSF IME insertion support#214
millionart wants to merge 37 commits into
Open-Less:mainfrom
millionart:codex-fix-windows-ime-x86-registration

millionart commented May 3, 2026 •

edited by github-actions Bot

Loading

Uh oh!

github-actions Bot commented May 3, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Conversation

millionart commented May 3, 2026 • edited by github-actions Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

User description

Summary

Fixes Included

Validation

PR Type

Description

Diagram Walkthrough

File Walkthrough

Uh oh!

github-actions Bot commented May 3, 2026

PR Reviewer Guide 🔍

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

millionart commented May 3, 2026 •

edited by github-actions Bot

Loading